<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_09) on Sat Dec 29 12:31:15 CET 2012 -->
<meta http-equiv="Content-Type" content="text/html" charset="UTF-8">
<title>ProcessingTarget (gephi 0.8.2 API)</title>
<meta name="date" content="2012-12-29">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="ProcessingTarget (gephi 0.8.2 API)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProcessingTarget.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/preview/api/PreviewProperty.html" title="class in org.gephi.preview.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/preview/api/RenderTarget.html" title="interface in org.gephi.preview.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/preview/api/ProcessingTarget.html" target="_top">Frames</a></li>
<li><a href="ProcessingTarget.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.gephi.preview.api</div>
<h2 title="Interface ProcessingTarget" class="title">Interface ProcessingTarget</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../../org/gephi/preview/api/RenderTarget.html" title="interface in org.gephi.preview.api">RenderTarget</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ProcessingTarget</span>
extends <a href="../../../../org/gephi/preview/api/RenderTarget.html" title="interface in org.gephi.preview.api">RenderTarget</a></pre>
<div class="block">Rendering target to the <a href="http://processing.org">Processing</a> library.
 <p>
 Processing is using a <b>Java2D</b> mode so the underlying Processing object
 used is a <a href="http://processing.googlecode.com/svn/trunk/processing/build/javadoc/core/index.html?processing/core/PGraphicsJava2D.html">PGraphicsJava2D</a>
 object. 
 <p>
 This render target supports two modes: <b>applet</b> or <b>headless</b>. The 
 applet mode is what is used in Gephi GUI and is backed by a <code>PApplet</code>
 with zoom and pan control. The headless mode is tuned to work without GUI and 
 is typically used in exports. Either way users should use <code>getGraphics()</code>
 method for drawing.
 <h4>How to create a headless Processing canvas?</h4>
 Before creating a processing target with the <a href="../../../../org/gephi/preview/api/PreviewController.html#getRenderTarget(java.lang.String)"><code>PreviewController.getRenderTarget(java.lang.String)</code></a>
 method users should define a <b>width</b> and <b>height</b> property in the
 <a href="../../../../org/gephi/preview/api/PreviewProperties.html" title="class in org.gephi.preview.api"><code>PreviewProperties</code></a>:
 <pre>
 PreviewController previewController = Lookup.getDefault().lookup(PreviewController.class);
 PreviewModel model = previewController.getModel();
 PreviewProperties props = model.getProperties();
 props.putValue("width", 800);
 props.putValue("height", 600);
 ProcessingTarget target = (ProcessingTarget)previewController.getRenderTarget(RenderTarget.PROCESSING_TARGET);
 </pre></div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Mathieu Bastian</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="fields_inherited_from_class_org.gephi.preview.api.RenderTarget">
<!--   -->
</a>
<h3>Fields inherited from interface&nbsp;org.gephi.preview.api.<a href="../../../../org/gephi/preview/api/RenderTarget.html" title="interface in org.gephi.preview.api">RenderTarget</a></h3>
<code><a href="../../../../org/gephi/preview/api/RenderTarget.html#PDF_TARGET">PDF_TARGET</a>, <a href="../../../../org/gephi/preview/api/RenderTarget.html#PROCESSING_TARGET">PROCESSING_TARGET</a>, <a href="../../../../org/gephi/preview/api/RenderTarget.html#SVG_TARGET">SVG_TARGET</a></code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>processing.core.PApplet</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#getApplet()">getApplet</a></strong>()</code>
<div class="block">Returns the current applet if the mode is set to applet.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>processing.core.PGraphics</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#getGraphics()">getGraphics</a></strong>()</code>
<div class="block">Returns the current graphics object.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#isRedrawn()">isRedrawn</a></strong>()</code>
<div class="block">Returns <code>true</code> if the applet is finished redrawing</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#refresh()">refresh</a></strong>()</code>
<div class="block">Redraw the Processing canvas</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#resetZoom()">resetZoom</a></strong>()</code>
<div class="block">Resets the zoom level to default</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#zoomMinus()">zoomMinus</a></strong>()</code>
<div class="block">Zooms out</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/gephi/preview/api/ProcessingTarget.html#zoomPlus()">zoomPlus</a></strong>()</code>
<div class="block">Zooms in</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getGraphics()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getGraphics</h4>
<pre>processing.core.PGraphics&nbsp;getGraphics()</pre>
<div class="block">Returns the current graphics object. Use this method to draw to Processing.
 The <code>PGRraphics</code> object can be cast to <code>PGraphicsJava2D</code>.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current graphics to draw to</dd></dl>
</li>
</ul>
<a name="getApplet()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getApplet</h4>
<pre>processing.core.PApplet&nbsp;getApplet()</pre>
<div class="block">Returns the current applet if the mode is set to applet. If in headless
 mode returns <code>null</code>. Always use <code>getGraphics()</code>
 for drawing.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the current applet or <code>null</code> if in headless mode</dd></dl>
</li>
</ul>
<a name="resetZoom()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>resetZoom</h4>
<pre>void&nbsp;resetZoom()</pre>
<div class="block">Resets the zoom level to default</div>
</li>
</ul>
<a name="zoomPlus()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zoomPlus</h4>
<pre>void&nbsp;zoomPlus()</pre>
<div class="block">Zooms in</div>
</li>
</ul>
<a name="zoomMinus()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>zoomMinus</h4>
<pre>void&nbsp;zoomMinus()</pre>
<div class="block">Zooms out</div>
</li>
</ul>
<a name="refresh()">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>refresh</h4>
<pre>void&nbsp;refresh()</pre>
<div class="block">Redraw the Processing canvas</div>
</li>
</ul>
<a name="isRedrawn()">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>isRedrawn</h4>
<pre>boolean&nbsp;isRedrawn()</pre>
<div class="block">Returns <code>true</code> if the applet is finished redrawing</div>
<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the applet is redrawn, <code>false</code> otherwise</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/ProcessingTarget.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../org/gephi/preview/api/PreviewProperty.html" title="class in org.gephi.preview.api"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/gephi/preview/api/RenderTarget.html" title="interface in org.gephi.preview.api"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/gephi/preview/api/ProcessingTarget.html" target="_top">Frames</a></li>
<li><a href="ProcessingTarget.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2007-2012 <a href="http://consortium.gephi.org">Gephi Consortium</a>. All Rights Reserved.</small></p>
</body>
</html>
